HL7 FHIR Implementation Guide: ZM-Core Release 1 - Zambia
0.1.0 -
HL7 FHIR Implementation Guide: ZM-Core Release 1 - Zambia
0.1.0 -
HL7 FHIR Implementation Guide: ZM-Core Release 1 - Zambia - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication | Version: 0.1.0 | |||
| Draft as of 2026-08-12 | Computable Name: ZMCoreMedication | |||
Zambia Core Medication Profile aligned to the ZAMMSA national product catalogue and the eLMIS Master Product List.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots, and their representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Medication |
0..* | Medication | Definition of a Medication | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained |
0..* | Resource | Contained, inline Resources | |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
   extension:levelOfAccess |
0..* | CodeableConcept | ZM-Core Medication Level of Access URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-level-of-access | |
| extension:fullName |
0..1 | string | ZM-Core Medication Full Name URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-full-name | |
| extension:genericName |
0..1 | string | ZM-Core Medication Generic Name URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-generic-name | |
| extension:alternateName |
0..1 | string | ZM-Core Medication Alternate Name URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-alternate-name | |
| extension:description |
0..1 | string | ZM-Core Medication Description URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-description | |
| extension:strengthText |
0..1 | string | ZM-Core Medication Strength URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-strength | |
| extension:dosageUnit |
0..1 | CodeableConcept | ZM-Core Medication Dosage Unit URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-dosage-unit | |
| extension:dispensingUnits |
0..1 | string | ZM-Core Medication Dispensing Units URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-dispensing-units | |
| extension:dosesPerDispensingUnit |
0..1 | decimal | ZM-Core Medication Doses Per Dispensing Unit URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-doses-per-dispensing-unit | |
| extension:mslPackSize |
0..1 | decimal | ZM-Core Medication MSL Pack Size (numeric) URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-msl-pack-size | |
| extension:packSizeText |
0..1 | string | ZM-Core Medication Pack Size (text) URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-pack-size-text | |
| extension:alternatePackSize |
0..1 | string | ZM-Core Medication Alternate Pack Size URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-alternate-pack-size | |
| extension:packWeight |
0..1 | decimal | ZM-Core Medication Pack Weight URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-pack-weight | |
| extension:packsPerCarton |
0..1 | decimal | ZM-Core Medication Packs Per Carton URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-packs-per-carton | |
| extension:cartonsPerPallet |
0..1 | decimal | ZM-Core Medication Cartons Per Pallet URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-cartons-per-pallet | |
| extension:shelfLife |
0..1 | string | ZM-Core Medication Shelf Life URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-shelf-life | |
| extension:storageInstructions |
0..1 | string | ZM-Core Medication Storage Instructions URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-storage-instructions | |
| extension:transportInstructions |
0..1 | string | ZM-Core Medication Transport Instructions URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-transport-instructions | |
| extension:storeRefrigerated |
0..1 | boolean | ZM-Core Medication Store Refrigerated URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-store-refrigerated | |
| extension:routeOfAdministration |
0..1 | CodeableConcept | ZM-Core Medication Route of Administration URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-route-of-administration | |
| extension:atcClassification |
0..* | CodeableConcept | ZM-Core Medication ATC Classification URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-atc-classification | |
| extension:storageClassification |
0..1 | CodeableConcept | ZM-Core Medication Storage Classification URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-storage-classification | |
| extension:storeRoomTemperature |
0..1 | decimal | ZM-Core Medication Store Room Temperature URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-store-room-temperature | |
| extension:isHazardous |
0..1 | boolean | ZM-Core Medication Hazardous URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-hazardous | |
| extension:isFlammable |
0..1 | boolean | ZM-Core Medication Flammable URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-flammable | |
| extension:isControlledSubstance |
0..1 | boolean | ZM-Core Medication Controlled Substance URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-controlled-substance | |
| extension:isLightSensitive |
0..1 | boolean | ZM-Core Medication Light Sensitive URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-light-sensitive | |
| extension:approvedByWHO |
0..1 | boolean | ZM-Core Medication WHO Approved URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-who-approved | |
| extension:isFullSupply |
0..1 | boolean | ZM-Core Medication Full Supply URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-full-supply | |
| extension:isTracer |
0..1 | boolean | ZM-Core Medication Tracer URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-tracer | |
| extension:packRoundingThreshold |
0..1 | decimal | ZM-Core Medication Pack Rounding Threshold URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-pack-rounding-threshold | |
| extension:canRoundToZero |
0..1 | boolean | ZM-Core Medication Can Round To Zero URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-can-round-to-zero | |
| extension:archived |
0..1 | boolean | ZM-Core Medication Archived URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-archived | |
| extension:lsiEnabled |
0..1 | boolean | Medication LSI Enabled URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-lsi-enabled | |
| extension:price |
0..1 | Money | ZM-Core Medication Price URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-price | |
| extension:productType |
0..1 | CodeableConcept | ZM-Core Medication Product Type URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-product-type | |
 extension:productGroup |
0..1 | CodeableConcept | ZM-Core Medication Product Group URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-product-group | |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
 Slices for identifier |
SΣ | 2..* | Identifier | Business identifier for this medication Slice: Unordered, Open by value:system |
 identifier:programItemCode |
SΣ | 1..1 | Identifier | Business identifier for this medication |
  use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
 type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://hapi.moh.gov.zm/fhir/CodeSystem/medication-program-item-code |
 value |
SΣC | 1..1 | string | The value that is unique Example General: 123456 |
| identifier:zammsaSKU |
SΣ | 1..1 | Identifier | Business identifier for this medication |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://hapi.moh.gov.zm/fhir/CodeSystem/medication-zammsa-sku |
| value |
SΣC | 1..1 | string | The value that is unique Example General: 123456 |
| identifier:altItemCode |
SΣ | 0..1 | Identifier | Business identifier for this medication |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://hapi.moh.gov.zm/fhir/CodeSystem/medication-alt-item-code |
| value |
SΣC | 1..1 | string | The value that is unique Example General: 123456 |
| identifier:mohBarCode |
SΣ | 0..1 | Identifier | Business identifier for this medication |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://hapi.moh.gov.zm/fhir/CodeSystem/medication-moh-bar-code |
| value |
SΣC | 1..1 | string | The value that is unique Example General: 123456 |
 identifier:gtin |
SΣ | 0..1 | Identifier | Business identifier for this medication |
 use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://hapi.moh.gov.zm/fhir/CodeSystem/medication-gtin |
| value |
SΣC | 1..1 | string | The value that is unique Example General: 123456 |
| code |
SΣ | 1..1 | CodeableConcept | Codes that identify this medication Binding: ZAMMSA Medication SKU ValueSet (required) |
| coding |
SΣ | 1..1 | Coding | Code defined by a terminology system |
| system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://hapi.moh.gov.zm/fhir/CodeSystem/medication-zammsa-sku |
| code |
SΣC | 1..1 | code | Symbol in syntax defined by the system |
 display |
SΣC | 0..1 | string | Representation defined by the system |
| text |
SΣ | 1..1 | string | Plain text representation of the concept |
| status |
?!SΣ | 1..1 | code | active | inactive | entered-in-error Binding: MedicationStatusCodes (required): A coded concept defining if the medication is in active use. Required Pattern: active |
 marketingAuthorizationHolder |
SΣ | 0..1 | Reference(Organization) | Marketing authorization holder (e.g. ZAMMSA or manufacturer; align with SDP/contract). |
| doseForm |
S | 1..1 | CodeableConcept | Pharmaceutical dose form (e.g. tablet, syrup, injection) Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication. |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Medication.identifier:programItemCode.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Medication.identifier:programItemCode.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| Medication.identifier:zammsaSKU.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Medication.identifier:zammsaSKU.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| Medication.identifier:altItemCode.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Medication.identifier:mohBarCode.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Medication.identifier:mohBarCode.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| Medication.identifier:gtin.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Medication.identifier:gtin.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| Medication.code | Base | required | ZAMMSA Medication SKU ValueSet | 📦0.1.0 | This IG |
| Medication.status | Base | required | Medication Status Codes | 📍5.0.0 | FHIR Std. |
| Medication.doseForm | Base | example | SNOMED CT Form Codes | 📍5.0.0 | FHIR Std. |
| Medication.ingredient.item | Base | example | SNOMED CT Medication Codes | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Medication | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Medication | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Medication | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Medication | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Medication | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| Path | Status | Usage | ValueSet | Version | Source |
| Medication.code | Base | required | ZAMMSA Medication SKU ValueSet | 📦0.1.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Medication |
0..* | Medication | Definition of a Medication | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:levelOfAccess |
0..* | CodeableConcept | ZM-Core Medication Level of Access URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-level-of-access | |||||
| extension:fullName |
0..1 | string | ZM-Core Medication Full Name URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-full-name | |||||
| extension:genericName |
0..1 | string | ZM-Core Medication Generic Name URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-generic-name | |||||
| extension:alternateName |
0..1 | string | ZM-Core Medication Alternate Name URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-alternate-name | |||||
| extension:description |
0..1 | string | ZM-Core Medication Description URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-description | |||||
| extension:strengthText |
0..1 | string | ZM-Core Medication Strength URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-strength | |||||
| extension:dosageUnit |
0..1 | CodeableConcept | ZM-Core Medication Dosage Unit URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-dosage-unit | |||||
| extension:dispensingUnits |
0..1 | string | ZM-Core Medication Dispensing Units URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-dispensing-units | |||||
| extension:dosesPerDispensingUnit |
0..1 | decimal | ZM-Core Medication Doses Per Dispensing Unit URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-doses-per-dispensing-unit | |||||
| extension:mslPackSize |
0..1 | decimal | ZM-Core Medication MSL Pack Size (numeric) URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-msl-pack-size | |||||
| extension:packSizeText |
0..1 | string | ZM-Core Medication Pack Size (text) URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-pack-size-text | |||||
| extension:alternatePackSize |
0..1 | string | ZM-Core Medication Alternate Pack Size URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-alternate-pack-size | |||||
| extension:packWeight |
0..1 | decimal | ZM-Core Medication Pack Weight URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-pack-weight | |||||
| extension:packsPerCarton |
0..1 | decimal | ZM-Core Medication Packs Per Carton URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-packs-per-carton | |||||
| extension:cartonsPerPallet |
0..1 | decimal | ZM-Core Medication Cartons Per Pallet URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-cartons-per-pallet | |||||
| extension:shelfLife |
0..1 | string | ZM-Core Medication Shelf Life URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-shelf-life | |||||
| extension:storageInstructions |
0..1 | string | ZM-Core Medication Storage Instructions URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-storage-instructions | |||||
| extension:transportInstructions |
0..1 | string | ZM-Core Medication Transport Instructions URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-transport-instructions | |||||
| extension:storeRefrigerated |
0..1 | boolean | ZM-Core Medication Store Refrigerated URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-store-refrigerated | |||||
| extension:routeOfAdministration |
0..1 | CodeableConcept | ZM-Core Medication Route of Administration URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-route-of-administration | |||||
| extension:atcClassification |
0..* | CodeableConcept | ZM-Core Medication ATC Classification URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-atc-classification | |||||
| extension:storageClassification |
0..1 | CodeableConcept | ZM-Core Medication Storage Classification URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-storage-classification | |||||
| extension:storeRoomTemperature |
0..1 | decimal | ZM-Core Medication Store Room Temperature URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-store-room-temperature | |||||
| extension:isHazardous |
0..1 | boolean | ZM-Core Medication Hazardous URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-hazardous | |||||
| extension:isFlammable |
0..1 | boolean | ZM-Core Medication Flammable URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-flammable | |||||
| extension:isControlledSubstance |
0..1 | boolean | ZM-Core Medication Controlled Substance URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-controlled-substance | |||||
| extension:isLightSensitive |
0..1 | boolean | ZM-Core Medication Light Sensitive URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-light-sensitive | |||||
| extension:approvedByWHO |
0..1 | boolean | ZM-Core Medication WHO Approved URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-who-approved | |||||
| extension:isFullSupply |
0..1 | boolean | ZM-Core Medication Full Supply URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-full-supply | |||||
| extension:isTracer |
0..1 | boolean | ZM-Core Medication Tracer URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-tracer | |||||
| extension:packRoundingThreshold |
0..1 | decimal | ZM-Core Medication Pack Rounding Threshold URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-pack-rounding-threshold | |||||
| extension:canRoundToZero |
0..1 | boolean | ZM-Core Medication Can Round To Zero URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-can-round-to-zero | |||||
| extension:archived |
0..1 | boolean | ZM-Core Medication Archived URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-archived | |||||
| extension:lsiEnabled |
0..1 | boolean | Medication LSI Enabled URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-lsi-enabled | |||||
| extension:price |
0..1 | Money | ZM-Core Medication Price URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-price | |||||
| extension:productType |
0..1 | CodeableConcept | ZM-Core Medication Product Type URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-product-type | |||||
| extension:productGroup |
0..1 | CodeableConcept | ZM-Core Medication Product Group URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-product-group | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier |
SΣ | 2..* | Identifier | Business identifier for this medication Slice: Unordered, Open by value:system | ||||
| identifier:programItemCode |
SΣ | 1..1 | Identifier | Business identifier for this medication | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://hapi.moh.gov.zm/fhir/CodeSystem/medication-program-item-code | ||||
| value |
SΣC | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:zammsaSKU |
SΣ | 1..1 | Identifier | Business identifier for this medication | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://hapi.moh.gov.zm/fhir/CodeSystem/medication-zammsa-sku | ||||
| value |
SΣC | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:altItemCode |
SΣ | 0..1 | Identifier | Business identifier for this medication | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://hapi.moh.gov.zm/fhir/CodeSystem/medication-alt-item-code | ||||
| value |
SΣC | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:mohBarCode |
SΣ | 0..1 | Identifier | Business identifier for this medication | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://hapi.moh.gov.zm/fhir/CodeSystem/medication-moh-bar-code | ||||
| value |
SΣC | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:gtin |
SΣ | 0..1 | Identifier | Business identifier for this medication | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://hapi.moh.gov.zm/fhir/CodeSystem/medication-gtin | ||||
| value |
SΣC | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| code |
SΣ | 1..1 | CodeableConcept | Codes that identify this medication Binding: ZAMMSA Medication SKU ValueSet (required) | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
SΣ | 1..1 | Coding | Code defined by a terminology system | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://hapi.moh.gov.zm/fhir/CodeSystem/medication-zammsa-sku | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
SΣC | 1..1 | code | Symbol in syntax defined by the system | ||||
| display |
SΣC | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text |
SΣ | 1..1 | string | Plain text representation of the concept | ||||
| status |
?!SΣ | 1..1 | code | active | inactive | entered-in-error Binding: MedicationStatusCodes (required): A coded concept defining if the medication is in active use. Required Pattern: active | ||||
| marketingAuthorizationHolder |
SΣ | 0..1 | Reference(Organization) | Marketing authorization holder (e.g. ZAMMSA or manufacturer; align with SDP/contract). | ||||
| doseForm |
S | 1..1 | CodeableConcept | Pharmaceutical dose form (e.g. tablet, syrup, injection) Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication. | ||||
| definition |
0..1 | Reference(MedicationKnowledge) | Knowledge about this medication | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Medication.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Medication.identifier:programItemCode.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Medication.identifier:programItemCode.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| Medication.identifier:zammsaSKU.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Medication.identifier:zammsaSKU.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| Medication.identifier:altItemCode.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Medication.identifier:altItemCode.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| Medication.identifier:mohBarCode.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Medication.identifier:mohBarCode.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| Medication.identifier:gtin.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Medication.identifier:gtin.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| Medication.code | Base | required | ZAMMSA Medication SKU ValueSet | 📦0.1.0 | This IG |
| Medication.status | Base | required | Medication Status Codes | 📍5.0.0 | FHIR Std. |
| Medication.doseForm | Base | example | SNOMED CT Form Codes | 📍5.0.0 | FHIR Std. |
| Medication.ingredient.item | Base | example | SNOMED CT Medication Codes | 📍5.0.0 | FHIR Std. |
| Medication.ingredient.strength[x] | Base | preferred | Medication Ingredient Strength Codes | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Medication | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Medication | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Medication | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Medication | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Medication | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Summary
Mandatory: 15 elements(8 nested mandatory elements)
Must-Support: 29 elements
Prohibited: 3 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Medication |
0..* | Medication | Definition of a Medication | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained |
0..* | Resource | Contained, inline Resources | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:levelOfAccess |
0..* | CodeableConcept | ZM-Core Medication Level of Access URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-level-of-access | |
| extension:fullName |
0..1 | string | ZM-Core Medication Full Name URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-full-name | |
| extension:genericName |
0..1 | string | ZM-Core Medication Generic Name URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-generic-name | |
| extension:alternateName |
0..1 | string | ZM-Core Medication Alternate Name URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-alternate-name | |
| extension:description |
0..1 | string | ZM-Core Medication Description URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-description | |
| extension:strengthText |
0..1 | string | ZM-Core Medication Strength URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-strength | |
| extension:dosageUnit |
0..1 | CodeableConcept | ZM-Core Medication Dosage Unit URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-dosage-unit | |
| extension:dispensingUnits |
0..1 | string | ZM-Core Medication Dispensing Units URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-dispensing-units | |
| extension:dosesPerDispensingUnit |
0..1 | decimal | ZM-Core Medication Doses Per Dispensing Unit URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-doses-per-dispensing-unit | |
| extension:mslPackSize |
0..1 | decimal | ZM-Core Medication MSL Pack Size (numeric) URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-msl-pack-size | |
| extension:packSizeText |
0..1 | string | ZM-Core Medication Pack Size (text) URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-pack-size-text | |
| extension:alternatePackSize |
0..1 | string | ZM-Core Medication Alternate Pack Size URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-alternate-pack-size | |
| extension:packWeight |
0..1 | decimal | ZM-Core Medication Pack Weight URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-pack-weight | |
| extension:packsPerCarton |
0..1 | decimal | ZM-Core Medication Packs Per Carton URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-packs-per-carton | |
| extension:cartonsPerPallet |
0..1 | decimal | ZM-Core Medication Cartons Per Pallet URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-cartons-per-pallet | |
| extension:shelfLife |
0..1 | string | ZM-Core Medication Shelf Life URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-shelf-life | |
| extension:storageInstructions |
0..1 | string | ZM-Core Medication Storage Instructions URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-storage-instructions | |
| extension:transportInstructions |
0..1 | string | ZM-Core Medication Transport Instructions URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-transport-instructions | |
| extension:storeRefrigerated |
0..1 | boolean | ZM-Core Medication Store Refrigerated URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-store-refrigerated | |
| extension:routeOfAdministration |
0..1 | CodeableConcept | ZM-Core Medication Route of Administration URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-route-of-administration | |
| extension:atcClassification |
0..* | CodeableConcept | ZM-Core Medication ATC Classification URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-atc-classification | |
| extension:storageClassification |
0..1 | CodeableConcept | ZM-Core Medication Storage Classification URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-storage-classification | |
| extension:storeRoomTemperature |
0..1 | decimal | ZM-Core Medication Store Room Temperature URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-store-room-temperature | |
| extension:isHazardous |
0..1 | boolean | ZM-Core Medication Hazardous URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-hazardous | |
| extension:isFlammable |
0..1 | boolean | ZM-Core Medication Flammable URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-flammable | |
| extension:isControlledSubstance |
0..1 | boolean | ZM-Core Medication Controlled Substance URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-controlled-substance | |
| extension:isLightSensitive |
0..1 | boolean | ZM-Core Medication Light Sensitive URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-light-sensitive | |
| extension:approvedByWHO |
0..1 | boolean | ZM-Core Medication WHO Approved URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-who-approved | |
| extension:isFullSupply |
0..1 | boolean | ZM-Core Medication Full Supply URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-full-supply | |
| extension:isTracer |
0..1 | boolean | ZM-Core Medication Tracer URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-tracer | |
| extension:packRoundingThreshold |
0..1 | decimal | ZM-Core Medication Pack Rounding Threshold URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-pack-rounding-threshold | |
| extension:canRoundToZero |
0..1 | boolean | ZM-Core Medication Can Round To Zero URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-can-round-to-zero | |
| extension:archived |
0..1 | boolean | ZM-Core Medication Archived URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-archived | |
| extension:lsiEnabled |
0..1 | boolean | Medication LSI Enabled URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-lsi-enabled | |
| extension:price |
0..1 | Money | ZM-Core Medication Price URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-price | |
| extension:productType |
0..1 | CodeableConcept | ZM-Core Medication Product Type URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-product-type | |
| extension:productGroup |
0..1 | CodeableConcept | ZM-Core Medication Product Group URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-product-group | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier |
SΣ | 2..* | Identifier | Business identifier for this medication Slice: Unordered, Open by value:system |
| identifier:programItemCode |
SΣ | 1..1 | Identifier | Business identifier for this medication |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://hapi.moh.gov.zm/fhir/CodeSystem/medication-program-item-code |
| value |
SΣC | 1..1 | string | The value that is unique Example General: 123456 |
| identifier:zammsaSKU |
SΣ | 1..1 | Identifier | Business identifier for this medication |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://hapi.moh.gov.zm/fhir/CodeSystem/medication-zammsa-sku |
| value |
SΣC | 1..1 | string | The value that is unique Example General: 123456 |
| identifier:altItemCode |
SΣ | 0..1 | Identifier | Business identifier for this medication |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://hapi.moh.gov.zm/fhir/CodeSystem/medication-alt-item-code |
| value |
SΣC | 1..1 | string | The value that is unique Example General: 123456 |
| identifier:mohBarCode |
SΣ | 0..1 | Identifier | Business identifier for this medication |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://hapi.moh.gov.zm/fhir/CodeSystem/medication-moh-bar-code |
| value |
SΣC | 1..1 | string | The value that is unique Example General: 123456 |
| identifier:gtin |
SΣ | 0..1 | Identifier | Business identifier for this medication |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://hapi.moh.gov.zm/fhir/CodeSystem/medication-gtin |
| value |
SΣC | 1..1 | string | The value that is unique Example General: 123456 |
| code |
SΣ | 1..1 | CodeableConcept | Codes that identify this medication Binding: ZAMMSA Medication SKU ValueSet (required) |
| coding |
SΣ | 1..1 | Coding | Code defined by a terminology system |
| system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://hapi.moh.gov.zm/fhir/CodeSystem/medication-zammsa-sku |
| code |
SΣC | 1..1 | code | Symbol in syntax defined by the system |
| display |
SΣC | 0..1 | string | Representation defined by the system |
| text |
SΣ | 1..1 | string | Plain text representation of the concept |
| status |
?!SΣ | 1..1 | code | active | inactive | entered-in-error Binding: MedicationStatusCodes (required): A coded concept defining if the medication is in active use. Required Pattern: active |
| marketingAuthorizationHolder |
SΣ | 0..1 | Reference(Organization) | Marketing authorization holder (e.g. ZAMMSA or manufacturer; align with SDP/contract). |
| doseForm |
S | 1..1 | CodeableConcept | Pharmaceutical dose form (e.g. tablet, syrup, injection) Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication. |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Medication.identifier:programItemCode.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Medication.identifier:programItemCode.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| Medication.identifier:zammsaSKU.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Medication.identifier:zammsaSKU.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| Medication.identifier:altItemCode.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Medication.identifier:mohBarCode.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Medication.identifier:mohBarCode.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| Medication.identifier:gtin.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Medication.identifier:gtin.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| Medication.code | Base | required | ZAMMSA Medication SKU ValueSet | 📦0.1.0 | This IG |
| Medication.status | Base | required | Medication Status Codes | 📍5.0.0 | FHIR Std. |
| Medication.doseForm | Base | example | SNOMED CT Form Codes | 📍5.0.0 | FHIR Std. |
| Medication.ingredient.item | Base | example | SNOMED CT Medication Codes | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Medication | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Medication | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Medication | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Medication | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Medication | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
| Path | Status | Usage | ValueSet | Version | Source |
| Medication.code | Base | required | ZAMMSA Medication SKU ValueSet | 📦0.1.0 | This IG |
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Medication |
0..* | Medication | Definition of a Medication | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:levelOfAccess |
0..* | CodeableConcept | ZM-Core Medication Level of Access URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-level-of-access | |||||
| extension:fullName |
0..1 | string | ZM-Core Medication Full Name URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-full-name | |||||
| extension:genericName |
0..1 | string | ZM-Core Medication Generic Name URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-generic-name | |||||
| extension:alternateName |
0..1 | string | ZM-Core Medication Alternate Name URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-alternate-name | |||||
| extension:description |
0..1 | string | ZM-Core Medication Description URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-description | |||||
| extension:strengthText |
0..1 | string | ZM-Core Medication Strength URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-strength | |||||
| extension:dosageUnit |
0..1 | CodeableConcept | ZM-Core Medication Dosage Unit URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-dosage-unit | |||||
| extension:dispensingUnits |
0..1 | string | ZM-Core Medication Dispensing Units URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-dispensing-units | |||||
| extension:dosesPerDispensingUnit |
0..1 | decimal | ZM-Core Medication Doses Per Dispensing Unit URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-doses-per-dispensing-unit | |||||
| extension:mslPackSize |
0..1 | decimal | ZM-Core Medication MSL Pack Size (numeric) URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-msl-pack-size | |||||
| extension:packSizeText |
0..1 | string | ZM-Core Medication Pack Size (text) URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-pack-size-text | |||||
| extension:alternatePackSize |
0..1 | string | ZM-Core Medication Alternate Pack Size URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-alternate-pack-size | |||||
| extension:packWeight |
0..1 | decimal | ZM-Core Medication Pack Weight URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-pack-weight | |||||
| extension:packsPerCarton |
0..1 | decimal | ZM-Core Medication Packs Per Carton URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-packs-per-carton | |||||
| extension:cartonsPerPallet |
0..1 | decimal | ZM-Core Medication Cartons Per Pallet URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-cartons-per-pallet | |||||
| extension:shelfLife |
0..1 | string | ZM-Core Medication Shelf Life URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-shelf-life | |||||
| extension:storageInstructions |
0..1 | string | ZM-Core Medication Storage Instructions URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-storage-instructions | |||||
| extension:transportInstructions |
0..1 | string | ZM-Core Medication Transport Instructions URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-transport-instructions | |||||
| extension:storeRefrigerated |
0..1 | boolean | ZM-Core Medication Store Refrigerated URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-store-refrigerated | |||||
| extension:routeOfAdministration |
0..1 | CodeableConcept | ZM-Core Medication Route of Administration URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-route-of-administration | |||||
| extension:atcClassification |
0..* | CodeableConcept | ZM-Core Medication ATC Classification URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-atc-classification | |||||
| extension:storageClassification |
0..1 | CodeableConcept | ZM-Core Medication Storage Classification URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-storage-classification | |||||
| extension:storeRoomTemperature |
0..1 | decimal | ZM-Core Medication Store Room Temperature URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-store-room-temperature | |||||
| extension:isHazardous |
0..1 | boolean | ZM-Core Medication Hazardous URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-hazardous | |||||
| extension:isFlammable |
0..1 | boolean | ZM-Core Medication Flammable URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-flammable | |||||
| extension:isControlledSubstance |
0..1 | boolean | ZM-Core Medication Controlled Substance URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-controlled-substance | |||||
| extension:isLightSensitive |
0..1 | boolean | ZM-Core Medication Light Sensitive URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-light-sensitive | |||||
| extension:approvedByWHO |
0..1 | boolean | ZM-Core Medication WHO Approved URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-who-approved | |||||
| extension:isFullSupply |
0..1 | boolean | ZM-Core Medication Full Supply URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-full-supply | |||||
| extension:isTracer |
0..1 | boolean | ZM-Core Medication Tracer URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-tracer | |||||
| extension:packRoundingThreshold |
0..1 | decimal | ZM-Core Medication Pack Rounding Threshold URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-pack-rounding-threshold | |||||
| extension:canRoundToZero |
0..1 | boolean | ZM-Core Medication Can Round To Zero URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-can-round-to-zero | |||||
| extension:archived |
0..1 | boolean | ZM-Core Medication Archived URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-archived | |||||
| extension:lsiEnabled |
0..1 | boolean | Medication LSI Enabled URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-lsi-enabled | |||||
| extension:price |
0..1 | Money | ZM-Core Medication Price URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-price | |||||
| extension:productType |
0..1 | CodeableConcept | ZM-Core Medication Product Type URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-product-type | |||||
| extension:productGroup |
0..1 | CodeableConcept | ZM-Core Medication Product Group URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-medication-product-group | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier |
SΣ | 2..* | Identifier | Business identifier for this medication Slice: Unordered, Open by value:system | ||||
| identifier:programItemCode |
SΣ | 1..1 | Identifier | Business identifier for this medication | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://hapi.moh.gov.zm/fhir/CodeSystem/medication-program-item-code | ||||
| value |
SΣC | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:zammsaSKU |
SΣ | 1..1 | Identifier | Business identifier for this medication | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://hapi.moh.gov.zm/fhir/CodeSystem/medication-zammsa-sku | ||||
| value |
SΣC | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:altItemCode |
SΣ | 0..1 | Identifier | Business identifier for this medication | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://hapi.moh.gov.zm/fhir/CodeSystem/medication-alt-item-code | ||||
| value |
SΣC | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:mohBarCode |
SΣ | 0..1 | Identifier | Business identifier for this medication | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://hapi.moh.gov.zm/fhir/CodeSystem/medication-moh-bar-code | ||||
| value |
SΣC | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:gtin |
SΣ | 0..1 | Identifier | Business identifier for this medication | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://hapi.moh.gov.zm/fhir/CodeSystem/medication-gtin | ||||
| value |
SΣC | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| code |
SΣ | 1..1 | CodeableConcept | Codes that identify this medication Binding: ZAMMSA Medication SKU ValueSet (required) | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
SΣ | 1..1 | Coding | Code defined by a terminology system | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://hapi.moh.gov.zm/fhir/CodeSystem/medication-zammsa-sku | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
SΣC | 1..1 | code | Symbol in syntax defined by the system | ||||
| display |
SΣC | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text |
SΣ | 1..1 | string | Plain text representation of the concept | ||||
| status |
?!SΣ | 1..1 | code | active | inactive | entered-in-error Binding: MedicationStatusCodes (required): A coded concept defining if the medication is in active use. Required Pattern: active | ||||
| marketingAuthorizationHolder |
SΣ | 0..1 | Reference(Organization) | Marketing authorization holder (e.g. ZAMMSA or manufacturer; align with SDP/contract). | ||||
| doseForm |
S | 1..1 | CodeableConcept | Pharmaceutical dose form (e.g. tablet, syrup, injection) Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication. | ||||
| definition |
0..1 | Reference(MedicationKnowledge) | Knowledge about this medication | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Medication.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Medication.identifier:programItemCode.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Medication.identifier:programItemCode.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| Medication.identifier:zammsaSKU.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Medication.identifier:zammsaSKU.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| Medication.identifier:altItemCode.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Medication.identifier:altItemCode.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| Medication.identifier:mohBarCode.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Medication.identifier:mohBarCode.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| Medication.identifier:gtin.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Medication.identifier:gtin.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| Medication.code | Base | required | ZAMMSA Medication SKU ValueSet | 📦0.1.0 | This IG |
| Medication.status | Base | required | Medication Status Codes | 📍5.0.0 | FHIR Std. |
| Medication.doseForm | Base | example | SNOMED CT Form Codes | 📍5.0.0 | FHIR Std. |
| Medication.ingredient.item | Base | example | SNOMED CT Medication Codes | 📍5.0.0 | FHIR Std. |
| Medication.ingredient.strength[x] | Base | preferred | Medication Ingredient Strength Codes | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Medication | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Medication | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Medication | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Medication | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Medication | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Summary
Mandatory: 15 elements(8 nested mandatory elements)
Must-Support: 29 elements
Prohibited: 3 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
